Ensure all subcommands have summary description documentation

Almost all commands have info on what they are for, but a few were
missing it.

Also cleans up some copy/paste misdocumentation along the way.

diff --git a/src/bin/git_checkout.rs b/src/bin/git_checkout.rs
index 42b6562af1e1cf34dc6e78cd3cacb73123c43fc5..82daf45876cf6e7d4690e4065e2a2299f4a49546 100644 (file)
--- a/src/bin/git_checkout.rs
+++ b/src/bin/git_checkout.rs
@@ -12,6 +12,8 @@ struct Options {
 }
 
 pub const USAGE: &'static str = "
+Checkout a copy of a Git repository
+
 Usage:
     cargo git-checkout [options] --url=URL --reference=REF
     cargo git-checkout -h | --help

diff --git a/src/bin/locate_project.rs b/src/bin/locate_project.rs
index e9fb4345401c0234e95d85821c1c9281cab09490..005e60b5a33c07bbf34b13a7aa102bea40512547 100644 (file)
--- a/src/bin/locate_project.rs
+++ b/src/bin/locate_project.rs
@@ -7,11 +7,13 @@ struct LocateProjectFlags {
 }
 
 pub const USAGE: &'static str = "
+Print a JSON representation of a Cargo.toml file's location
+
 Usage:
     cargo locate-project [options]
 
 Options:
-    --manifest-path PATH    Path to the manifest to build benchmarks for
+    --manifest-path PATH    Path to the manifest to locate
     -h, --help              Print this message
 ";
 

diff --git a/src/bin/publish.rs b/src/bin/publish.rs
index fdbbd4ffcf90fa5a4106a985585261ec91baf33c..246057cab7edc1141224f2859788a41de687ddea 100644 (file)
--- a/src/bin/publish.rs
+++ b/src/bin/publish.rs
@@ -24,7 +24,7 @@ Options:
     --host HOST              Host to upload the package to
     --token TOKEN            Token to use when uploading
     --no-verify              Don't verify package tarball before publish
-    --manifest-path PATH     Path to the manifest to compile
+    --manifest-path PATH     Path to the manifest of the package to publish
     -v, --verbose            Use verbose output
     -q, --quiet              No output printed to stdout
     --color WHEN             Coloring: auto, always, never

diff --git a/src/bin/read_manifest.rs b/src/bin/read_manifest.rs
index 3793108568dd723f86bc98c34d0fd9710caf5863..9e8d81e4b72b346a961910ec2f2f7fc962f877fe 100644 (file)
--- a/src/bin/read_manifest.rs
+++ b/src/bin/read_manifest.rs
@@ -12,6 +12,8 @@ struct Options {
 }
 
 pub const USAGE: &'static str = "
+Print a JSON representation of a Cargo.toml manifest
+
 Usage:
     cargo read-manifest [options]
     cargo read-manifest -h | --help
@@ -19,7 +21,7 @@ Usage:
 Options:
     -h, --help               Print this message
     -v, --verbose            Use verbose output
-    --manifest-path PATH     Path to the manifest to compile
+    --manifest-path PATH     Path to the manifest
     --color WHEN             Coloring: auto, always, never
 ";
 

diff --git a/src/bin/update.rs b/src/bin/update.rs
index 92647cfcc433705bade853a2f05e8544bbcbfb8b..00866a2a80eae4c11f297f5cc056a616e6c3d9b8 100644 (file)
--- a/src/bin/update.rs
+++ b/src/bin/update.rs
@@ -26,7 +26,7 @@ Options:
     -p SPEC, --package SPEC ...  Package to update
     --aggressive                 Force updating all dependencies of <name> as well
     --precise PRECISE            Update a single dependency to exactly PRECISE
-    --manifest-path PATH         Path to the manifest to compile
+    --manifest-path PATH         Path to the crate's manifest
     -v, --verbose                Use verbose output
     -q, --quiet                  No output printed to stdout
     --color WHEN                 Coloring: auto, always, never
@@ -68,4 +68,3 @@ pub fn execute(options: Options, config: &Config) -> CliResult<Option<()>> {
     try!(ops::update_lockfile(&root, &update_opts));
     Ok(None)
 }
-

diff --git a/src/bin/verify_project.rs b/src/bin/verify_project.rs
index 962a0340f0dce178c51a544431e3ae7b4f7d8091..5cbd027f3d671c6718deb861ffdf267a80b82c6c 100644 (file)
--- a/src/bin/verify_project.rs
+++ b/src/bin/verify_project.rs
@@ -19,6 +19,8 @@ struct Flags {
 }
 
 pub const USAGE: &'static str = "
+Check correctness of crate manifest
+
 Usage:
     cargo verify-project [options]
     cargo verify-project -h | --help

diff --git a/src/bin/version.rs b/src/bin/version.rs
index 12c954f58c48eafb9163818cf5c31966be704541..87402f7ccbca2378bd0bc7055c777c67a8fa496f 100644 (file)
--- a/src/bin/version.rs
+++ b/src/bin/version.rs
@@ -7,6 +7,8 @@ use cargo::util::{CliResult, Config};
 struct Options;
 
 pub const USAGE: &'static str = "
+Show version information
+
 Usage:
     cargo version [options]